This API documentation provides information on the Scaleform® Common Lightweight Interface Kit (CLIK™) framework and the ActionScript 2.0 classes that it is composed of.
The CLIK framework is designed to help quickly prototype user interfaces and take them to completion through all phases of the production pipeline. It consists of several core classes for basic component types, component management and inter- and intra- component communication. These classes form the foundation of CLIK, and are used by the set of prebuilt components that are distributed with this kit.
CLIK is distributed with several prebuilt interface elements that can be easily skinned and customized to create interfaces in multimedia applications that use Scaleform GFx. These components range from basic types such as buttons and checkboxes, to complex components such as list boxes, drop down menus and modal dialog boxes.
These CLIK Help pages describe the methods and properties of the core classes and are classified under the following sections:
• gfx.controls - contains classes used by standard controls such as the Button component.
• gfx.core - contains base classes used by all CLIK components.
• gfx.data - contains the concrete classes that provide data to components.
• gfx.events - contains classes used by the CLIK framework’s event model.
• gfx.interfaces - contains interfaces used by CLIK elements. These interfaces are not implemented directly and are provided only for reference.
• gfx.io - contains classes used to communicate with the operating game engine or operating system.
• gfx.managers – contains entities that manage focus, input, pop-ups, and so on.
• gfx.motion - contains tweening and animation specific utilities.
• gfx.ui -contains miscellaneous classes used by CLIK managers and the event model.
• gfx.utils - contains general purpose utility classes.
The CLIK framework architecture describes the foundation framework in more detail. This CLIK API documentation can also be viewed in Flash8 and CS3 by pressing F1. As a quick start to the CLIK components, please refer to the Getting Started with CLIK guide before reading through this documentation.
Other documents in the CLIK series:
– Scaleform CLIK User Guide, describing the Scaleform CLIK framework and the components with detailed implementation instructions.
– Getting Started with CLIK Buttons document, providing an in-depth description on the Button component states.